PokeKotlin API Reference/co.pokeapi.pokekotlin.model

Package-level declarations

Types

@Serializable

data class Ability(val id: Int, val name: String, val isMainSeries: Boolean, val generation: NamedApiResource, val names: List<Name>, val effectEntries: List<VerboseEffect>, val effectChanges: List<AbilityEffectChange>, val flavorTextEntries: List<AbilityFlavorText>, val pokemon: List<AbilityPokemon>)

AbilityEffectChange

@Serializable

data class AbilityEffectChange(val effectEntries: List<Effect>, val versionGroup: NamedApiResource)

AbilityFlavorText

@Serializable

data class AbilityFlavorText(val flavorText: String, val language: NamedApiResource, val versionGroup: NamedApiResource)

AbilityPokemon

@Serializable

data class AbilityPokemon(val isHidden: Boolean, val slot: Int, val pokemon: NamedApiResource)

ApiResource

@Serializable(with = ApiResource.Serializer::class)

data class ApiResource(val url: String) : ResourceSummary

ApiResourceList

@Serializable

data class ApiResourceList(val count: Int, val next: String?, val previous: String?, val results: List<ApiResource>) : ResourceSummaryList<ApiResource>

AwesomeName

@Serializable

data class AwesomeName(val awesomeName: String, val language: NamedApiResource)

Berry

@Serializable

data class Berry(val id: Int, val name: String, val growthTime: Int, val maxHarvest: Int, val naturalGiftPower: Int, val size: Int, val smoothness: Int, val soilDryness: Int, val firmness: NamedApiResource, val flavors: List<BerryFlavorMap>, val item: NamedApiResource, val naturalGiftType: NamedApiResource)

BerryFirmness

@Serializable

data class BerryFirmness(val id: Int, val name: String, val berries: List<NamedApiResource>, val names: List<Name>)

BerryFlavor

@Serializable

data class BerryFlavor(val id: Int, val name: String, val berries: List<FlavorBerryMap>, val contestType: NamedApiResource, val names: List<Name>)

BerryFlavorMap

@Serializable

data class BerryFlavorMap(val potency: Int, val flavor: NamedApiResource)

ChainLink

@Serializable

data class ChainLink(val isBaby: Boolean, val species: NamedApiResource, val evolutionDetails: List<EvolutionDetail>, val evolvesTo: List<ChainLink>)

Characteristic

@Serializable

data class Characteristic(val id: Int, val geneModulo: Int, val possibleValues: List<Int>, val descriptions: List<Description>)

ContestComboDetail

@Serializable

data class ContestComboDetail(val useBefore: List<NamedApiResource>?, val useAfter: List<NamedApiResource>?)

ContestComboSets

@Serializable

data class ContestComboSets(val normalSet: ContestComboDetail, val superSet: ContestComboDetail)

ContestEffect

@Serializable

data class ContestEffect(val id: Int, val appeal: Int, val jam: Int, val effectEntries: List<Effect>, val flavorTextEntries: List<FlavorText>)

ContestName

@Serializable

data class ContestName(val name: String, val color: String, val language: NamedApiResource)

ContestType

@Serializable

data class ContestType(val id: Int, val name: String, val berryFlavor: NamedApiResource, val names: List<ContestName>)

Description

@Serializable

data class Description(val description: String, val language: NamedApiResource)

Effect

@Serializable

data class Effect(val effect: String, val language: NamedApiResource)

EggGroup

@Serializable

data class EggGroup(val id: Int, val name: String, val names: List<Name>, val pokemonSpecies: List<NamedApiResource>)

Encounter

@Serializable

data class Encounter(val minLevel: Int, val maxLevel: Int, val conditionValues: List<NamedApiResource>, val chance: Int, val method: NamedApiResource)

EncounterCondition

@Serializable

data class EncounterCondition(val id: Int, val name: String, val names: List<Name>, val values: List<NamedApiResource>)

EncounterConditionValue

@Serializable

data class EncounterConditionValue(val id: Int, val name: String, val condition: NamedApiResource, val names: List<Name>)

EncounterMethod

@Serializable

data class EncounterMethod(val id: Int, val name: String, val order: Int, val names: List<Name>)

EncounterMethodRate

@Serializable

data class EncounterMethodRate(val encounterMethod: NamedApiResource, val versionDetails: List<EncounterMethodRateVersionDetail>)

EncounterMethodRateVersionDetail

@Serializable

data class EncounterMethodRateVersionDetail(val rate: Int, val version: NamedApiResource)

EvolutionChain

@Serializable

data class EvolutionChain(val id: Int, val babyTriggerItem: NamedApiResource?, val chain: ChainLink)

EvolutionDetail

@Serializable

data class EvolutionDetail(val trigger: NamedApiResource, val item: NamedApiResource? = null, val gender: Int? = null, val heldItem: NamedApiResource? = null, val knownMove: NamedApiResource? = null, val knownMoveType: NamedApiResource? = null, val location: NamedApiResource? = null, val minLevel: Int? = null, val minHappiness: Int? = null, val minBeauty: Int? = null, val minAffection: Int? = null, val partySpecies: NamedApiResource? = null, val partyType: NamedApiResource? = null, val relativePhysicalStats: Int? = null, val timeOfDay: String = "", val tradeSpecies: NamedApiResource? = null, val needsOverworldRain: Boolean = false, val turnUpsideDown: Boolean = false)

EvolutionTrigger

@Serializable

data class EvolutionTrigger(val id: Int, val name: String, val names: List<Name>, val pokemonSpecies: List<NamedApiResource>)

FlavorBerryMap

@Serializable

data class FlavorBerryMap(val potency: Int, val berry: NamedApiResource)

FlavorText

@Serializable

data class FlavorText(val flavorText: String, val language: NamedApiResource)

Gender

@Serializable

data class Gender(val id: Int, val name: String, val pokemonSpeciesDetails: List<PokemonSpeciesGender>, val requiredForEvolution: List<NamedApiResource>)

Generation

@Serializable

data class Generation(val id: Int, val name: String, val abilities: List<NamedApiResource>, val names: List<Name>, val mainRegion: NamedApiResource, val moves: List<NamedApiResource>, val pokemonSpecies: List<NamedApiResource>, val types: List<NamedApiResource>, val versionGroups: List<NamedApiResource>)

GenerationGameIndex

@Serializable

data class GenerationGameIndex(val gameIndex: Int, val generation: NamedApiResource)

Genus

@Serializable

data class Genus(val genus: String, val language: NamedApiResource)

GrowthRate

@Serializable

data class GrowthRate(val id: Int, val name: String, val formula: String, val descriptions: List<Description>, val levels: List<GrowthRateExperienceLevel>, val pokemonSpecies: List<NamedApiResource>)

GrowthRateExperienceLevel

@Serializable

data class GrowthRateExperienceLevel(val level: Int, val experience: Int)

Item

@Serializable

data class Item(val id: Int, val name: String, val cost: Int, val flingPower: Int?, val flingEffect: NamedApiResource?, val attributes: List<NamedApiResource>, val category: NamedApiResource, val effectEntries: List<VerboseEffect>, val flavorTextEntries: List<VersionGroupFlavorText>, val gameIndices: List<GenerationGameIndex>, val names: List<Name>, val heldByPokemon: List<ItemHolderPokemon>, val babyTriggerFor: ApiResource?, val sprites: ItemSprites, val machines: List<MachineVersionDetail>)

ItemAttribute

@Serializable

data class ItemAttribute(val id: Int, val name: String, val items: List<NamedApiResource>, val names: List<Name>, val descriptions: List<Description>)

ItemCategory

@Serializable

data class ItemCategory(val id: Int, val name: String, val items: List<NamedApiResource>, val names: List<Name>, val pocket: NamedApiResource)

ItemFlingEffect

@Serializable

data class ItemFlingEffect(val id: Int, val name: String, val effectEntries: List<Effect>, val items: List<NamedApiResource>)

ItemHolderPokemon

@Serializable

data class ItemHolderPokemon(val pokemon: NamedApiResource, val versionDetails: List<ItemHolderPokemonVersionDetail>)

ItemHolderPokemonVersionDetail

@Serializable

data class ItemHolderPokemonVersionDetail(val rarity: Int, val version: NamedApiResource)

ItemPocket

@Serializable

data class ItemPocket(val id: Int, val name: String, val categories: List<NamedApiResource>, val names: List<Name>)

ItemSprites

@Serializable

data class ItemSprites(val default: String?)

Language

@Serializable

data class Language(val id: Int, val name: String, val official: Boolean, val iso639: String, val iso3166: String, val names: List<Name>)

Location

@Serializable

data class Location(val id: Int, val name: String, val region: NamedApiResource?, val names: List<Name>, val gameIndices: List<GenerationGameIndex>, val areas: List<NamedApiResource>)

LocationArea

@Serializable

data class LocationArea(val id: Int, val name: String, val gameIndex: Int, val encounterMethodRates: List<EncounterMethodRate>, val location: NamedApiResource, val names: List<Name>, val pokemonEncounters: List<PokemonEncounter>)

LocationAreaEncounter

@Serializable

data class LocationAreaEncounter(val locationArea: NamedApiResource, val versionDetails: List<VersionEncounterDetail>)

Machine

@Serializable

data class Machine(val id: Int, val item: NamedApiResource, val move: NamedApiResource, val versionGroup: NamedApiResource)

MachineVersionDetail

@Serializable

data class MachineVersionDetail(val machine: ApiResource, val versionGroup: NamedApiResource)

Move

@Serializable

data class Move(val id: Int, val name: String, val accuracy: Int?, val effectChance: Int?, val pp: Int?, val priority: Int, val power: Int?, val contestCombos: ContestComboSets?, val contestType: NamedApiResource?, val contestEffect: ApiResource?, val superContestEffect: ApiResource?, val damageClass: NamedApiResource, val effectEntries: List<VerboseEffect>, val effectChanges: List<AbilityEffectChange>, val generation: NamedApiResource, val meta: MoveMetaData?, val names: List<Name>, val pastValues: List<PastMoveStatValues>, val statChanges: List<MoveStatChange>, val target: NamedApiResource, val type: NamedApiResource, val machines: List<MachineVersionDetail>, val flavorTextEntries: List<MoveFlavorText>)

MoveAilment

@Serializable

data class MoveAilment(val id: Int, val name: String, val moves: List<NamedApiResource>, val names: List<Name>)

MoveBattleStyle

@Serializable

data class MoveBattleStyle(val id: Int, val name: String, val names: List<Name>)

MoveBattleStylePreference

@Serializable

data class MoveBattleStylePreference(val lowHpPreference: Int, val highHpPreference: Int, val moveBattleStyle: NamedApiResource)

MoveCategory

@Serializable

data class MoveCategory(val id: Int, val name: String, val moves: List<NamedApiResource>, val descriptions: List<Description>)

MoveDamageClass

@Serializable

data class MoveDamageClass(val id: Int, val name: String, val descriptions: List<Description>, val moves: List<NamedApiResource>, val names: List<Name>)

MoveFlavorText

@Serializable

data class MoveFlavorText(val flavorText: String, val language: NamedApiResource, val versionGroup: NamedApiResource)

MoveLearnMethod

@Serializable

data class MoveLearnMethod(val id: Int, val name: String, val descriptions: List<Description>, val names: List<Name>, val versionGroups: List<NamedApiResource>)

MoveMetaData

@Serializable

data class MoveMetaData(val ailment: NamedApiResource, val category: NamedApiResource, val minHits: Int?, val maxHits: Int?, val minTurns: Int?, val maxTurns: Int?, val drain: Int, val healing: Int, val critRate: Int, val ailmentChance: Int, val flinchChance: Int, val statChance: Int)

MoveStatAffect

@Serializable

data class MoveStatAffect(val change: Int, val move: NamedApiResource)

MoveStatAffectSets

@Serializable

data class MoveStatAffectSets(val increase: List<MoveStatAffect>, val decrease: List<MoveStatAffect>)

MoveStatChange

@Serializable

data class MoveStatChange(val change: Int, val stat: NamedApiResource)

MoveTarget

@Serializable

data class MoveTarget(val id: Int, val name: String, val descriptions: List<Description>, val moves: List<NamedApiResource>, val names: List<Name>)

Name

@Serializable

data class Name(val name: String, val language: NamedApiResource)

NamedApiResource

@Serializable(with = NamedApiResource.Serializer::class)

data class NamedApiResource(val name: String, val url: String) : ResourceSummary

NamedApiResourceList

@Serializable

data class NamedApiResourceList(val count: Int, val next: String?, val previous: String?, val results: List<NamedApiResource>) : ResourceSummaryList<NamedApiResource>

Nature

@Serializable

data class Nature(val id: Int, val name: String, val decreasedStat: NamedApiResource?, val increasedStat: NamedApiResource?, val hatesFlavor: NamedApiResource?, val likesFlavor: NamedApiResource?, val pokeathlonStatChanges: List<NatureStatChange>, val moveBattleStylePreferences: List<MoveBattleStylePreference>, val names: List<Name>)

NaturePokeathlonStatAffect

@Serializable

data class NaturePokeathlonStatAffect(val maxChange: Int, val nature: NamedApiResource)

NaturePokeathlonStatAffectSets

@Serializable

data class NaturePokeathlonStatAffectSets(val increase: List<NaturePokeathlonStatAffect>, val decrease: List<NaturePokeathlonStatAffect>)

NatureStatAffectSets

@Serializable

data class NatureStatAffectSets(val increase: List<NamedApiResource>, val decrease: List<NamedApiResource>)

NatureStatChange

@Serializable

data class NatureStatChange(val maxChange: Int, val pokeathlonStat: NamedApiResource)

PalParkArea

@Serializable

data class PalParkArea(val id: Int, val name: String, val names: List<Name>, val pokemonEncounters: List<PalParkEncounterSpecies>)

PalParkEncounterArea

@Serializable

data class PalParkEncounterArea(val baseScore: Int, val rate: Int, val area: NamedApiResource)

PalParkEncounterSpecies

@Serializable

data class PalParkEncounterSpecies(val baseScore: Int, val rate: Int, val pokemonSpecies: NamedApiResource)

PastMoveStatValues

@Serializable

data class PastMoveStatValues(val accuracy: Int?, val effectChance: Int?, val power: Int?, val pp: Int?, val effectEntries: List<VerboseEffect>, val type: NamedApiResource?, val versionGroup: NamedApiResource)

PokeathlonStat

@Serializable

data class PokeathlonStat(val id: Int, val name: String, val names: List<Name>, val affectingNatures: NaturePokeathlonStatAffectSets)

Pokedex

@Serializable

data class Pokedex(val id: Int, val name: String, val isMainSeries: Boolean, val descriptions: List<Description>, val names: List<Name>, val pokemonEntries: List<PokemonEntry>, val region: NamedApiResource?, val versionGroups: List<NamedApiResource>)

Pokemon

@Serializable

data class Pokemon(val id: Int, val name: String, val baseExperience: Int, val height: Int, val isDefault: Boolean, val order: Int, val weight: Int, val species: NamedApiResource, val abilities: List<PokemonAbility>, val forms: List<NamedApiResource>, val gameIndices: List<VersionGameIndex>, val heldItems: List<PokemonHeldItem>, val moves: List<PokemonMove>, val stats: List<PokemonStat>, val types: List<PokemonType>, val sprites: PokemonSprites)

PokemonAbility

@Serializable

data class PokemonAbility(val isHidden: Boolean, val slot: Int, val ability: NamedApiResource)

PokemonColor

@Serializable

data class PokemonColor(val id: Int, val name: String, val names: List<Name>, val pokemonSpecies: List<NamedApiResource>)

PokemonEncounter

@Serializable

data class PokemonEncounter(val pokemon: NamedApiResource, val versionDetails: List<VersionEncounterDetail>)

PokemonEntry

@Serializable

data class PokemonEntry(val entryNumber: Int, val pokemonSpecies: NamedApiResource)

PokemonForm

@Serializable

data class PokemonForm(val id: Int, val name: String, val order: Int, val formOrder: Int, val isDefault: Boolean, val isBattleOnly: Boolean, val isMega: Boolean, val formName: String, val pokemon: NamedApiResource, val versionGroup: NamedApiResource, val sprites: PokemonFormSprites, val formNames: List<Name>)

PokemonFormSprites

@Serializable

data class PokemonFormSprites(val backDefault: String?, val backShiny: String?, val frontDefault: String?, val frontShiny: String?)

PokemonHabitat

@Serializable

data class PokemonHabitat(val id: Int, val name: String, val names: List<Name>, val pokemonSpecies: List<NamedApiResource>)

PokemonHeldItem

@Serializable

data class PokemonHeldItem(val item: NamedApiResource, val versionDetails: List<PokemonHeldItemVersion>)

PokemonHeldItemVersion

@Serializable

data class PokemonHeldItemVersion(val version: NamedApiResource, val rarity: Int)

PokemonMove

@Serializable

data class PokemonMove(val move: NamedApiResource, val versionGroupDetails: List<PokemonMoveVersion>)

PokemonMoveVersion

@Serializable

data class PokemonMoveVersion(val moveLearnMethod: NamedApiResource, val versionGroup: NamedApiResource, val levelLearnedAt: Int)

PokemonShape

@Serializable

data class PokemonShape(val id: Int, val name: String, val awesomeNames: List<AwesomeName>, val names: List<Name>, val pokemonSpecies: List<NamedApiResource>)

PokemonSpecies

@Serializable

data class PokemonSpecies(val id: Int, val name: String, val order: Int, val genderRate: Int, val captureRate: Int, val baseHappiness: Int, val isBaby: Boolean, val isLegendary: Boolean? = null, val isMythical: Boolean? = null, val hatchCounter: Int, val hasGenderDifferences: Boolean, val formsSwitchable: Boolean, val growthRate: NamedApiResource, val pokedexNumbers: List<PokemonSpeciesDexEntry>, val eggGroups: List<NamedApiResource>, val color: NamedApiResource, val shape: NamedApiResource, val evolvesFromSpecies: NamedApiResource?, val evolutionChain: ApiResource, val habitat: NamedApiResource?, val generation: NamedApiResource, val names: List<Name>, val palParkEncounters: List<PalParkEncounterArea>, val formDescriptions: List<Description>, val genera: List<Genus>, val varieties: List<PokemonSpeciesVariety>, val flavorTextEntries: List<PokemonSpeciesFlavorText>)

PokemonSpeciesDexEntry

@Serializable

data class PokemonSpeciesDexEntry(val entryNumber: Int, val pokedex: NamedApiResource)

PokemonSpeciesFlavorText

@Serializable

data class PokemonSpeciesFlavorText(val flavorText: String, val language: NamedApiResource, val version: NamedApiResource)

PokemonSpeciesGender

@Serializable

data class PokemonSpeciesGender(val rate: Int, val pokemonSpecies: NamedApiResource)

PokemonSpeciesVariety

@Serializable

data class PokemonSpeciesVariety(val isDefault: Boolean, val pokemon: NamedApiResource)

PokemonSprites

@Serializable

data class PokemonSprites(val backDefault: String?, val backShiny: String?, val frontDefault: String?, val frontShiny: String?, val backFemale: String?, val backShinyFemale: String?, val frontFemale: String?, val frontShinyFemale: String?)

PokemonStat

@Serializable

data class PokemonStat(val stat: NamedApiResource, val effort: Int, val baseStat: Int)

PokemonType

@Serializable

data class PokemonType(val slot: Int, val type: NamedApiResource)

Region

@Serializable

data class Region(val id: Int, val name: String, val locations: List<NamedApiResource>, val mainGeneration: NamedApiResource?, val names: List<Name>, val pokedexes: List<NamedApiResource>, val versionGroups: List<NamedApiResource>)

ResourceSummary

interface ResourceSummary

ResourceSummaryList

interface ResourceSummaryList<out T : ResourceSummary>

Stat

@Serializable

data class Stat(val id: Int, val name: String, val gameIndex: Int, val isBattleOnly: Boolean, val affectingMoves: MoveStatAffectSets, val affectingNatures: NatureStatAffectSets, val characteristics: List<ApiResource>, val moveDamageClass: NamedApiResource?, val names: List<Name>)

SuperContestEffect

@Serializable

data class SuperContestEffect(val id: Int, val appeal: Int, val flavorTextEntries: List<FlavorText>, val moves: List<NamedApiResource>)

Type

@Serializable

data class Type(val id: Int, val name: String, val damageRelations: TypeRelations, val gameIndices: List<GenerationGameIndex>, val generation: NamedApiResource, val moveDamageClass: NamedApiResource?, val names: List<Name>, val pokemon: List<TypePokemon>, val moves: List<NamedApiResource>)

TypePokemon

@Serializable

data class TypePokemon(val slot: Int, val pokemon: NamedApiResource)

TypeRelations

@Serializable

data class TypeRelations(val noDamageTo: List<NamedApiResource>, val halfDamageTo: List<NamedApiResource>, val doubleDamageTo: List<NamedApiResource>, val noDamageFrom: List<NamedApiResource>, val halfDamageFrom: List<NamedApiResource>, val doubleDamageFrom: List<NamedApiResource>)

VerboseEffect

@Serializable

data class VerboseEffect(val effect: String, val shortEffect: String, val language: NamedApiResource)

Version

@Serializable

data class Version(val id: Int, val name: String, val names: List<Name>, val versionGroup: NamedApiResource)

VersionEncounterDetail

@Serializable

data class VersionEncounterDetail(val version: NamedApiResource, val maxChance: Int, val encounterDetails: List<Encounter>)

VersionGameIndex

@Serializable

data class VersionGameIndex(val gameIndex: Int, val version: NamedApiResource)

VersionGroup

@Serializable

data class VersionGroup(val id: Int, val name: String, val order: Int, val generation: NamedApiResource, val moveLearnMethods: List<NamedApiResource>, val pokedexes: List<NamedApiResource>, val regions: List<NamedApiResource>, val versions: List<NamedApiResource>)

VersionGroupFlavorText

@Serializable

data class VersionGroupFlavorText(val text: String, val language: NamedApiResource, val versionGroup: NamedApiResource)